hilitedButton

Type

property

Summary

Specifies which button in a group is currently highlighted.

Syntax

set the hilitedButton of <group> to <buttonNumber>

Description

Use the hilitedButton property to change the current setting in a radio-button cluster.

The hilitedButton specifies which button in a group is currently highlighted. If the hilitedButton of a group is zero, none of the buttons in the group is currently highlighted. If the hilitedButton is 1, the button with the lowest layer in the group is currently highlighted; if the hilitedButton is 2, the button with the second-lowest layer is currently highlighted; and so forth.

Setting the hilitedButton of a group sets the hilite property of the rest of the buttons to false.

The hilitedButton property is most useful in radio-button clusters. In a radio-button cluster, only one button can be highlighted at once: clicking another button unhighlights the first one. The radioBehavior property of a group of buttons specifies whether they act as a radio-button cluster.

The hilitedButton, hilitedButtonName, and hilitedButtonID properties all refer in different ways to the same button. When any of them changes, all of them change.

Examples

set the hilitedButton of group "Options" to 2 -- 2nd button in group

set the hilitedButton of group ID 8 to zero -- unhilites all buttons

Related

command: hilite, group

function: selectedButton

glossary: property, highlight, radio button, layer

keyword: integer, button

object: button

property: hilitedButtonName, radioBehavior, hilitedButtonName, hilitedButtonID

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile